<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.commons.net.telnet;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.BufferedInputStream;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.InputStream;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.io.OutputStream;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>/***<a name="line.25"></a>
<span class="sourceLineNo">026</span> * The TelnetClient class implements the simple network virtual<a name="line.26"></a>
<span class="sourceLineNo">027</span> * terminal (NVT) for the Telnet protocol according to RFC 854.  It<a name="line.27"></a>
<span class="sourceLineNo">028</span> * does not implement any of the extra Telnet options because it<a name="line.28"></a>
<span class="sourceLineNo">029</span> * is meant to be used within a Java program providing automated<a name="line.29"></a>
<span class="sourceLineNo">030</span> * access to Telnet accessible resources.<a name="line.30"></a>
<span class="sourceLineNo">031</span> * &lt;p&gt;<a name="line.31"></a>
<span class="sourceLineNo">032</span> * The class can be used by first connecting to a server using the<a name="line.32"></a>
<span class="sourceLineNo">033</span> * SocketClient<a name="line.33"></a>
<span class="sourceLineNo">034</span> * {@link org.apache.commons.net.SocketClient#connect connect}<a name="line.34"></a>
<span class="sourceLineNo">035</span> * method.  Then an InputStream and OutputStream for sending and<a name="line.35"></a>
<span class="sourceLineNo">036</span> * receiving data over the Telnet connection can be obtained by<a name="line.36"></a>
<span class="sourceLineNo">037</span> * using the {@link #getInputStream  getInputStream() } and<a name="line.37"></a>
<span class="sourceLineNo">038</span> * {@link #getOutputStream  getOutputStream() } methods.<a name="line.38"></a>
<span class="sourceLineNo">039</span> * When you finish using the streams, you must call<a name="line.39"></a>
<span class="sourceLineNo">040</span> * {@link #disconnect  disconnect } rather than simply<a name="line.40"></a>
<span class="sourceLineNo">041</span> * closing the streams.<a name="line.41"></a>
<span class="sourceLineNo">042</span> * &lt;p&gt;<a name="line.42"></a>
<span class="sourceLineNo">043</span> * &lt;p&gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span> * @author Bruno D'Avanzo<a name="line.44"></a>
<span class="sourceLineNo">045</span> ***/<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span>public class TelnetClient extends Telnet<a name="line.47"></a>
<span class="sourceLineNo">048</span>{<a name="line.48"></a>
<span class="sourceLineNo">049</span>    private InputStream __input;<a name="line.49"></a>
<span class="sourceLineNo">050</span>    private OutputStream __output;<a name="line.50"></a>
<span class="sourceLineNo">051</span>    protected boolean readerThread = true;<a name="line.51"></a>
<span class="sourceLineNo">052</span>    private TelnetInputListener inputListener;<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span>    /***<a name="line.54"></a>
<span class="sourceLineNo">055</span>     * Default TelnetClient constructor, sets terminal-type {@code VT100}.<a name="line.55"></a>
<span class="sourceLineNo">056</span>     ***/<a name="line.56"></a>
<span class="sourceLineNo">057</span>    public TelnetClient()<a name="line.57"></a>
<span class="sourceLineNo">058</span>    {<a name="line.58"></a>
<span class="sourceLineNo">059</span>        /* TERMINAL-TYPE option (start)*/<a name="line.59"></a>
<span class="sourceLineNo">060</span>        super ("VT100");<a name="line.60"></a>
<span class="sourceLineNo">061</span>        /* TERMINAL-TYPE option (end)*/<a name="line.61"></a>
<span class="sourceLineNo">062</span>        __input = null;<a name="line.62"></a>
<span class="sourceLineNo">063</span>        __output = null;<a name="line.63"></a>
<span class="sourceLineNo">064</span>    }<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span>    /**<a name="line.66"></a>
<span class="sourceLineNo">067</span>     * Construct an instance with the specified terminal type.<a name="line.67"></a>
<span class="sourceLineNo">068</span>     *<a name="line.68"></a>
<span class="sourceLineNo">069</span>     * @param termtype the terminal type to use, e.g. {@code VT100}<a name="line.69"></a>
<span class="sourceLineNo">070</span>     */<a name="line.70"></a>
<span class="sourceLineNo">071</span>    /* TERMINAL-TYPE option (start)*/<a name="line.71"></a>
<span class="sourceLineNo">072</span>    public TelnetClient(String termtype)<a name="line.72"></a>
<span class="sourceLineNo">073</span>    {<a name="line.73"></a>
<span class="sourceLineNo">074</span>        super (termtype);<a name="line.74"></a>
<span class="sourceLineNo">075</span>        __input = null;<a name="line.75"></a>
<span class="sourceLineNo">076</span>        __output = null;<a name="line.76"></a>
<span class="sourceLineNo">077</span>    }<a name="line.77"></a>
<span class="sourceLineNo">078</span>    /* TERMINAL-TYPE option (end)*/<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span>    void _flushOutputStream() throws IOException<a name="line.80"></a>
<span class="sourceLineNo">081</span>    {<a name="line.81"></a>
<span class="sourceLineNo">082</span>        _output_.flush();<a name="line.82"></a>
<span class="sourceLineNo">083</span>    }<a name="line.83"></a>
<span class="sourceLineNo">084</span>    void _closeOutputStream() throws IOException<a name="line.84"></a>
<span class="sourceLineNo">085</span>    {<a name="line.85"></a>
<span class="sourceLineNo">086</span>        _output_.close();<a name="line.86"></a>
<span class="sourceLineNo">087</span>    }<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span>    /***<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * Handles special connection requirements.<a name="line.90"></a>
<span class="sourceLineNo">091</span>     * &lt;p&gt;<a name="line.91"></a>
<span class="sourceLineNo">092</span>     * @exception IOException  If an error occurs during connection setup.<a name="line.92"></a>
<span class="sourceLineNo">093</span>     ***/<a name="line.93"></a>
<span class="sourceLineNo">094</span>    @Override<a name="line.94"></a>
<span class="sourceLineNo">095</span>    protected void _connectAction_() throws IOException<a name="line.95"></a>
<span class="sourceLineNo">096</span>    {<a name="line.96"></a>
<span class="sourceLineNo">097</span>        super._connectAction_();<a name="line.97"></a>
<span class="sourceLineNo">098</span>        TelnetInputStream tmp = new TelnetInputStream(_input_, this, readerThread);<a name="line.98"></a>
<span class="sourceLineNo">099</span>        if(readerThread)<a name="line.99"></a>
<span class="sourceLineNo">100</span>        {<a name="line.100"></a>
<span class="sourceLineNo">101</span>            tmp._start();<a name="line.101"></a>
<span class="sourceLineNo">102</span>        }<a name="line.102"></a>
<span class="sourceLineNo">103</span>        // __input CANNOT refer to the TelnetInputStream.  We run into<a name="line.103"></a>
<span class="sourceLineNo">104</span>        // blocking problems when some classes use TelnetInputStream, so<a name="line.104"></a>
<span class="sourceLineNo">105</span>        // we wrap it with a BufferedInputStream which we know is safe.<a name="line.105"></a>
<span class="sourceLineNo">106</span>        // This blocking behavior requires further investigation, but right<a name="line.106"></a>
<span class="sourceLineNo">107</span>        // now it looks like classes like InputStreamReader are not implemented<a name="line.107"></a>
<span class="sourceLineNo">108</span>        // in a safe manner.<a name="line.108"></a>
<span class="sourceLineNo">109</span>        __input = new BufferedInputStream(tmp);<a name="line.109"></a>
<span class="sourceLineNo">110</span>        __output = new TelnetOutputStream(this);<a name="line.110"></a>
<span class="sourceLineNo">111</span>    }<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span>    /***<a name="line.113"></a>
<span class="sourceLineNo">114</span>     * Disconnects the telnet session, closing the input and output streams<a name="line.114"></a>
<span class="sourceLineNo">115</span>     * as well as the socket.  If you have references to the<a name="line.115"></a>
<span class="sourceLineNo">116</span>     * input and output streams of the telnet connection, you should not<a name="line.116"></a>
<span class="sourceLineNo">117</span>     * close them yourself, but rather call disconnect to properly close<a name="line.117"></a>
<span class="sourceLineNo">118</span>     * the connection.<a name="line.118"></a>
<span class="sourceLineNo">119</span>     ***/<a name="line.119"></a>
<span class="sourceLineNo">120</span>    @Override<a name="line.120"></a>
<span class="sourceLineNo">121</span>    public void disconnect() throws IOException<a name="line.121"></a>
<span class="sourceLineNo">122</span>    {<a name="line.122"></a>
<span class="sourceLineNo">123</span>        if (__input != null) {<a name="line.123"></a>
<span class="sourceLineNo">124</span>            __input.close();<a name="line.124"></a>
<span class="sourceLineNo">125</span>        }<a name="line.125"></a>
<span class="sourceLineNo">126</span>        if (__output != null) {<a name="line.126"></a>
<span class="sourceLineNo">127</span>            __output.close();<a name="line.127"></a>
<span class="sourceLineNo">128</span>        }<a name="line.128"></a>
<span class="sourceLineNo">129</span>        super.disconnect();<a name="line.129"></a>
<span class="sourceLineNo">130</span>    }<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span>    /***<a name="line.132"></a>
<span class="sourceLineNo">133</span>     * Returns the telnet connection output stream.  You should not close the<a name="line.133"></a>
<span class="sourceLineNo">134</span>     * stream when you finish with it.  Rather, you should call<a name="line.134"></a>
<span class="sourceLineNo">135</span>     * {@link #disconnect  disconnect }.<a name="line.135"></a>
<span class="sourceLineNo">136</span>     * &lt;p&gt;<a name="line.136"></a>
<span class="sourceLineNo">137</span>     * @return The telnet connection output stream.<a name="line.137"></a>
<span class="sourceLineNo">138</span>     ***/<a name="line.138"></a>
<span class="sourceLineNo">139</span>    public OutputStream getOutputStream()<a name="line.139"></a>
<span class="sourceLineNo">140</span>    {<a name="line.140"></a>
<span class="sourceLineNo">141</span>        return __output;<a name="line.141"></a>
<span class="sourceLineNo">142</span>    }<a name="line.142"></a>
<span class="sourceLineNo">143</span><a name="line.143"></a>
<span class="sourceLineNo">144</span>    /***<a name="line.144"></a>
<span class="sourceLineNo">145</span>     * Returns the telnet connection input stream.  You should not close the<a name="line.145"></a>
<span class="sourceLineNo">146</span>     * stream when you finish with it.  Rather, you should call<a name="line.146"></a>
<span class="sourceLineNo">147</span>     * {@link #disconnect  disconnect }.<a name="line.147"></a>
<span class="sourceLineNo">148</span>     * &lt;p&gt;<a name="line.148"></a>
<span class="sourceLineNo">149</span>     * @return The telnet connection input stream.<a name="line.149"></a>
<span class="sourceLineNo">150</span>     ***/<a name="line.150"></a>
<span class="sourceLineNo">151</span>    public InputStream getInputStream()<a name="line.151"></a>
<span class="sourceLineNo">152</span>    {<a name="line.152"></a>
<span class="sourceLineNo">153</span>        return __input;<a name="line.153"></a>
<span class="sourceLineNo">154</span>    }<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span>    /***<a name="line.156"></a>
<span class="sourceLineNo">157</span>     * Returns the state of the option on the local side.<a name="line.157"></a>
<span class="sourceLineNo">158</span>     * &lt;p&gt;<a name="line.158"></a>
<span class="sourceLineNo">159</span>     * @param option - Option to be checked.<a name="line.159"></a>
<span class="sourceLineNo">160</span>     * &lt;p&gt;<a name="line.160"></a>
<span class="sourceLineNo">161</span>     * @return The state of the option on the local side.<a name="line.161"></a>
<span class="sourceLineNo">162</span>     ***/<a name="line.162"></a>
<span class="sourceLineNo">163</span>    public boolean getLocalOptionState(int option)<a name="line.163"></a>
<span class="sourceLineNo">164</span>    {<a name="line.164"></a>
<span class="sourceLineNo">165</span>        /* BUG (option active when not already acknowledged) (start)*/<a name="line.165"></a>
<span class="sourceLineNo">166</span>        return (_stateIsWill(option) &amp;&amp; _requestedWill(option));<a name="line.166"></a>
<span class="sourceLineNo">167</span>        /* BUG (option active when not already acknowledged) (end)*/<a name="line.167"></a>
<span class="sourceLineNo">168</span>    }<a name="line.168"></a>
<span class="sourceLineNo">169</span><a name="line.169"></a>
<span class="sourceLineNo">170</span>    /***<a name="line.170"></a>
<span class="sourceLineNo">171</span>     * Returns the state of the option on the remote side.<a name="line.171"></a>
<span class="sourceLineNo">172</span>     * &lt;p&gt;<a name="line.172"></a>
<span class="sourceLineNo">173</span>     * @param option - Option to be checked.<a name="line.173"></a>
<span class="sourceLineNo">174</span>     * &lt;p&gt;<a name="line.174"></a>
<span class="sourceLineNo">175</span>     * @return The state of the option on the remote side.<a name="line.175"></a>
<span class="sourceLineNo">176</span>     ***/<a name="line.176"></a>
<span class="sourceLineNo">177</span>    public boolean getRemoteOptionState(int option)<a name="line.177"></a>
<span class="sourceLineNo">178</span>    {<a name="line.178"></a>
<span class="sourceLineNo">179</span>        /* BUG (option active when not already acknowledged) (start)*/<a name="line.179"></a>
<span class="sourceLineNo">180</span>        return (_stateIsDo(option) &amp;&amp; _requestedDo(option));<a name="line.180"></a>
<span class="sourceLineNo">181</span>        /* BUG (option active when not already acknowledged) (end)*/<a name="line.181"></a>
<span class="sourceLineNo">182</span>    }<a name="line.182"></a>
<span class="sourceLineNo">183</span>    /* open TelnetOptionHandler functionality (end)*/<a name="line.183"></a>
<span class="sourceLineNo">184</span><a name="line.184"></a>
<span class="sourceLineNo">185</span>    /* Code Section added for supporting AYT (start)*/<a name="line.185"></a>
<span class="sourceLineNo">186</span><a name="line.186"></a>
<span class="sourceLineNo">187</span>    /***<a name="line.187"></a>
<span class="sourceLineNo">188</span>     * Sends an Are You There sequence and waits for the result.<a name="line.188"></a>
<span class="sourceLineNo">189</span>     * &lt;p&gt;<a name="line.189"></a>
<span class="sourceLineNo">190</span>     * @param timeout - Time to wait for a response (millis.)<a name="line.190"></a>
<span class="sourceLineNo">191</span>     * &lt;p&gt;<a name="line.191"></a>
<span class="sourceLineNo">192</span>     * @return true if AYT received a response, false otherwise<a name="line.192"></a>
<span class="sourceLineNo">193</span>     * &lt;p&gt;<a name="line.193"></a>
<span class="sourceLineNo">194</span>     * @throws InterruptedException<a name="line.194"></a>
<span class="sourceLineNo">195</span>     * @throws IllegalArgumentException<a name="line.195"></a>
<span class="sourceLineNo">196</span>     * @throws IOException<a name="line.196"></a>
<span class="sourceLineNo">197</span>     ***/<a name="line.197"></a>
<span class="sourceLineNo">198</span>    public boolean sendAYT(long timeout)<a name="line.198"></a>
<span class="sourceLineNo">199</span>    throws IOException, IllegalArgumentException, InterruptedException<a name="line.199"></a>
<span class="sourceLineNo">200</span>    {<a name="line.200"></a>
<span class="sourceLineNo">201</span>        return (_sendAYT(timeout));<a name="line.201"></a>
<span class="sourceLineNo">202</span>    }<a name="line.202"></a>
<span class="sourceLineNo">203</span>    /* Code Section added for supporting AYT (start)*/<a name="line.203"></a>
<span class="sourceLineNo">204</span><a name="line.204"></a>
<span class="sourceLineNo">205</span>    /***<a name="line.205"></a>
<span class="sourceLineNo">206</span>     * Sends a protocol-specific subnegotiation message to the remote peer.<a name="line.206"></a>
<span class="sourceLineNo">207</span>     * {@link TelnetClient} will add the IAC SB &amp;amp; IAC SE framing bytes;<a name="line.207"></a>
<span class="sourceLineNo">208</span>     * the first byte in {@code message} should be the appropriate telnet<a name="line.208"></a>
<span class="sourceLineNo">209</span>     * option code.<a name="line.209"></a>
<span class="sourceLineNo">210</span>     *<a name="line.210"></a>
<span class="sourceLineNo">211</span>     * &lt;p&gt;<a name="line.211"></a>
<span class="sourceLineNo">212</span>     * This method does not wait for any response. Subnegotiation messages<a name="line.212"></a>
<span class="sourceLineNo">213</span>     * sent by the remote end can be handled by registering an approrpriate<a name="line.213"></a>
<span class="sourceLineNo">214</span>     * {@link TelnetOptionHandler}.<a name="line.214"></a>
<span class="sourceLineNo">215</span>     * &lt;/p&gt;<a name="line.215"></a>
<span class="sourceLineNo">216</span>     *<a name="line.216"></a>
<span class="sourceLineNo">217</span>     * @param message option code followed by subnegotiation payload<a name="line.217"></a>
<span class="sourceLineNo">218</span>     * @throws IllegalArgumentException if {@code message} has length zero<a name="line.218"></a>
<span class="sourceLineNo">219</span>     * @throws IOException if an I/O error occurs while writing the message<a name="line.219"></a>
<span class="sourceLineNo">220</span>     * @since 3.0<a name="line.220"></a>
<span class="sourceLineNo">221</span>     ***/<a name="line.221"></a>
<span class="sourceLineNo">222</span>    public void sendSubnegotiation(int[] message)<a name="line.222"></a>
<span class="sourceLineNo">223</span>    throws IOException, IllegalArgumentException<a name="line.223"></a>
<span class="sourceLineNo">224</span>    {<a name="line.224"></a>
<span class="sourceLineNo">225</span>        if (message.length &lt; 1) {<a name="line.225"></a>
<span class="sourceLineNo">226</span>            throw new IllegalArgumentException("zero length message");<a name="line.226"></a>
<span class="sourceLineNo">227</span>        }<a name="line.227"></a>
<span class="sourceLineNo">228</span>        _sendSubnegotiation(message);<a name="line.228"></a>
<span class="sourceLineNo">229</span>    }<a name="line.229"></a>
<span class="sourceLineNo">230</span><a name="line.230"></a>
<span class="sourceLineNo">231</span>    /***<a name="line.231"></a>
<span class="sourceLineNo">232</span>     * Sends a command byte to the remote peer, adding the IAC prefix.<a name="line.232"></a>
<span class="sourceLineNo">233</span>     *<a name="line.233"></a>
<span class="sourceLineNo">234</span>     * &lt;p&gt;<a name="line.234"></a>
<span class="sourceLineNo">235</span>     * This method does not wait for any response. Messages<a name="line.235"></a>
<span class="sourceLineNo">236</span>     * sent by the remote end can be handled by registering an approrpriate<a name="line.236"></a>
<span class="sourceLineNo">237</span>     * {@link TelnetOptionHandler}.<a name="line.237"></a>
<span class="sourceLineNo">238</span>     * &lt;/p&gt;<a name="line.238"></a>
<span class="sourceLineNo">239</span>     *<a name="line.239"></a>
<span class="sourceLineNo">240</span>     * @param command the code for the command<a name="line.240"></a>
<span class="sourceLineNo">241</span>     * @throws IOException if an I/O error occurs while writing the message<a name="line.241"></a>
<span class="sourceLineNo">242</span>     * @since 3.0<a name="line.242"></a>
<span class="sourceLineNo">243</span>     ***/<a name="line.243"></a>
<span class="sourceLineNo">244</span>    public void sendCommand(byte command)<a name="line.244"></a>
<span class="sourceLineNo">245</span>    throws IOException, IllegalArgumentException<a name="line.245"></a>
<span class="sourceLineNo">246</span>    {<a name="line.246"></a>
<span class="sourceLineNo">247</span>        _sendCommand(command);<a name="line.247"></a>
<span class="sourceLineNo">248</span>    }<a name="line.248"></a>
<span class="sourceLineNo">249</span><a name="line.249"></a>
<span class="sourceLineNo">250</span>    /* open TelnetOptionHandler functionality (start)*/<a name="line.250"></a>
<span class="sourceLineNo">251</span><a name="line.251"></a>
<span class="sourceLineNo">252</span>    /***<a name="line.252"></a>
<span class="sourceLineNo">253</span>     * Registers a new TelnetOptionHandler for this telnet client to use.<a name="line.253"></a>
<span class="sourceLineNo">254</span>     * &lt;p&gt;<a name="line.254"></a>
<span class="sourceLineNo">255</span>     * @param opthand - option handler to be registered.<a name="line.255"></a>
<span class="sourceLineNo">256</span>     * &lt;p&gt;<a name="line.256"></a>
<span class="sourceLineNo">257</span>     * @throws InvalidTelnetOptionException<a name="line.257"></a>
<span class="sourceLineNo">258</span>     * @throws IOException<a name="line.258"></a>
<span class="sourceLineNo">259</span>     ***/<a name="line.259"></a>
<span class="sourceLineNo">260</span>    @Override<a name="line.260"></a>
<span class="sourceLineNo">261</span>    public void addOptionHandler(TelnetOptionHandler opthand)<a name="line.261"></a>
<span class="sourceLineNo">262</span>    throws InvalidTelnetOptionException, IOException<a name="line.262"></a>
<span class="sourceLineNo">263</span>    {<a name="line.263"></a>
<span class="sourceLineNo">264</span>        super.addOptionHandler(opthand);<a name="line.264"></a>
<span class="sourceLineNo">265</span>    }<a name="line.265"></a>
<span class="sourceLineNo">266</span>    /* open TelnetOptionHandler functionality (end)*/<a name="line.266"></a>
<span class="sourceLineNo">267</span><a name="line.267"></a>
<span class="sourceLineNo">268</span>    /***<a name="line.268"></a>
<span class="sourceLineNo">269</span>     * Unregisters a  TelnetOptionHandler.<a name="line.269"></a>
<span class="sourceLineNo">270</span>     * &lt;p&gt;<a name="line.270"></a>
<span class="sourceLineNo">271</span>     * @param optcode - Code of the option to be unregistered.<a name="line.271"></a>
<span class="sourceLineNo">272</span>     * &lt;p&gt;<a name="line.272"></a>
<span class="sourceLineNo">273</span>     * @throws InvalidTelnetOptionException<a name="line.273"></a>
<span class="sourceLineNo">274</span>     * @throws IOException<a name="line.274"></a>
<span class="sourceLineNo">275</span>     ***/<a name="line.275"></a>
<span class="sourceLineNo">276</span>    @Override<a name="line.276"></a>
<span class="sourceLineNo">277</span>    public void deleteOptionHandler(int optcode)<a name="line.277"></a>
<span class="sourceLineNo">278</span>    throws InvalidTelnetOptionException, IOException<a name="line.278"></a>
<span class="sourceLineNo">279</span>    {<a name="line.279"></a>
<span class="sourceLineNo">280</span>        super.deleteOptionHandler(optcode);<a name="line.280"></a>
<span class="sourceLineNo">281</span>    }<a name="line.281"></a>
<span class="sourceLineNo">282</span><a name="line.282"></a>
<span class="sourceLineNo">283</span>    /* Code Section added for supporting spystreams (start)*/<a name="line.283"></a>
<span class="sourceLineNo">284</span>    /***<a name="line.284"></a>
<span class="sourceLineNo">285</span>     * Registers an OutputStream for spying what's going on in<a name="line.285"></a>
<span class="sourceLineNo">286</span>     * the TelnetClient session.<a name="line.286"></a>
<span class="sourceLineNo">287</span>     * &lt;p&gt;<a name="line.287"></a>
<span class="sourceLineNo">288</span>     * @param spystream - OutputStream on which session activity<a name="line.288"></a>
<span class="sourceLineNo">289</span>     * will be echoed.<a name="line.289"></a>
<span class="sourceLineNo">290</span>     ***/<a name="line.290"></a>
<span class="sourceLineNo">291</span>    public void registerSpyStream(OutputStream  spystream)<a name="line.291"></a>
<span class="sourceLineNo">292</span>    {<a name="line.292"></a>
<span class="sourceLineNo">293</span>        super._registerSpyStream(spystream);<a name="line.293"></a>
<span class="sourceLineNo">294</span>    }<a name="line.294"></a>
<span class="sourceLineNo">295</span><a name="line.295"></a>
<span class="sourceLineNo">296</span>    /***<a name="line.296"></a>
<span class="sourceLineNo">297</span>     * Stops spying this TelnetClient.<a name="line.297"></a>
<span class="sourceLineNo">298</span>     * &lt;p&gt;<a name="line.298"></a>
<span class="sourceLineNo">299</span>     ***/<a name="line.299"></a>
<span class="sourceLineNo">300</span>    public void stopSpyStream()<a name="line.300"></a>
<span class="sourceLineNo">301</span>    {<a name="line.301"></a>
<span class="sourceLineNo">302</span>        super._stopSpyStream();<a name="line.302"></a>
<span class="sourceLineNo">303</span>    }<a name="line.303"></a>
<span class="sourceLineNo">304</span>    /* Code Section added for supporting spystreams (end)*/<a name="line.304"></a>
<span class="sourceLineNo">305</span><a name="line.305"></a>
<span class="sourceLineNo">306</span>    /***<a name="line.306"></a>
<span class="sourceLineNo">307</span>     * Registers a notification handler to which will be sent<a name="line.307"></a>
<span class="sourceLineNo">308</span>     * notifications of received telnet option negotiation commands.<a name="line.308"></a>
<span class="sourceLineNo">309</span>     * &lt;p&gt;<a name="line.309"></a>
<span class="sourceLineNo">310</span>     * @param notifhand - TelnetNotificationHandler to be registered<a name="line.310"></a>
<span class="sourceLineNo">311</span>     ***/<a name="line.311"></a>
<span class="sourceLineNo">312</span>    @Override<a name="line.312"></a>
<span class="sourceLineNo">313</span>    public void registerNotifHandler(TelnetNotificationHandler  notifhand)<a name="line.313"></a>
<span class="sourceLineNo">314</span>    {<a name="line.314"></a>
<span class="sourceLineNo">315</span>        super.registerNotifHandler(notifhand);<a name="line.315"></a>
<span class="sourceLineNo">316</span>    }<a name="line.316"></a>
<span class="sourceLineNo">317</span><a name="line.317"></a>
<span class="sourceLineNo">318</span>    /***<a name="line.318"></a>
<span class="sourceLineNo">319</span>     * Unregisters the current notification handler.<a name="line.319"></a>
<span class="sourceLineNo">320</span>     * &lt;p&gt;<a name="line.320"></a>
<span class="sourceLineNo">321</span>     ***/<a name="line.321"></a>
<span class="sourceLineNo">322</span>    @Override<a name="line.322"></a>
<span class="sourceLineNo">323</span>    public void unregisterNotifHandler()<a name="line.323"></a>
<span class="sourceLineNo">324</span>    {<a name="line.324"></a>
<span class="sourceLineNo">325</span>        super.unregisterNotifHandler();<a name="line.325"></a>
<span class="sourceLineNo">326</span>    }<a name="line.326"></a>
<span class="sourceLineNo">327</span><a name="line.327"></a>
<span class="sourceLineNo">328</span>    /***<a name="line.328"></a>
<span class="sourceLineNo">329</span>     * Sets the status of the reader thread.<a name="line.329"></a>
<span class="sourceLineNo">330</span>     *<a name="line.330"></a>
<span class="sourceLineNo">331</span>     * &lt;p&gt;<a name="line.331"></a>
<span class="sourceLineNo">332</span>     * When enabled, a seaparate internal reader thread is created for new<a name="line.332"></a>
<span class="sourceLineNo">333</span>     * connections to read incoming data as it arrives. This results in<a name="line.333"></a>
<span class="sourceLineNo">334</span>     * immediate handling of option negotiation, notifications, etc.<a name="line.334"></a>
<span class="sourceLineNo">335</span>     * (at least until the fixed-size internal buffer fills up).<a name="line.335"></a>
<span class="sourceLineNo">336</span>     * Otherwise, no thread is created an all negotiation and option<a name="line.336"></a>
<span class="sourceLineNo">337</span>     * handling is deferred until a read() is performed on the<a name="line.337"></a>
<span class="sourceLineNo">338</span>     * {@link #getInputStream input stream}.<a name="line.338"></a>
<span class="sourceLineNo">339</span>     * &lt;/p&gt;<a name="line.339"></a>
<span class="sourceLineNo">340</span>     *<a name="line.340"></a>
<span class="sourceLineNo">341</span>     * &lt;p&gt;<a name="line.341"></a>
<span class="sourceLineNo">342</span>     * The reader thread must be enabled for {@link TelnetInputListener}<a name="line.342"></a>
<span class="sourceLineNo">343</span>     * support.<a name="line.343"></a>
<span class="sourceLineNo">344</span>     * &lt;/p&gt;<a name="line.344"></a>
<span class="sourceLineNo">345</span>     *<a name="line.345"></a>
<span class="sourceLineNo">346</span>     * &lt;p&gt;<a name="line.346"></a>
<span class="sourceLineNo">347</span>     * When this method is invoked, the reader thread status will apply to all<a name="line.347"></a>
<span class="sourceLineNo">348</span>     * subsequent connections; the current connection (if any) is not affected.<a name="line.348"></a>
<span class="sourceLineNo">349</span>     * &lt;/p&gt;<a name="line.349"></a>
<span class="sourceLineNo">350</span>     *<a name="line.350"></a>
<span class="sourceLineNo">351</span>     * @param flag true to enable the reader thread, false to disable<a name="line.351"></a>
<span class="sourceLineNo">352</span>     * @see #registerInputListener<a name="line.352"></a>
<span class="sourceLineNo">353</span>     ***/<a name="line.353"></a>
<span class="sourceLineNo">354</span>    public void setReaderThread(boolean flag)<a name="line.354"></a>
<span class="sourceLineNo">355</span>    {<a name="line.355"></a>
<span class="sourceLineNo">356</span>        readerThread = flag;<a name="line.356"></a>
<span class="sourceLineNo">357</span>    }<a name="line.357"></a>
<span class="sourceLineNo">358</span><a name="line.358"></a>
<span class="sourceLineNo">359</span>    /***<a name="line.359"></a>
<span class="sourceLineNo">360</span>     * Gets the status of the reader thread.<a name="line.360"></a>
<span class="sourceLineNo">361</span>     * &lt;p&gt;<a name="line.361"></a>
<span class="sourceLineNo">362</span>     * @return true if the reader thread is enabled, false otherwise<a name="line.362"></a>
<span class="sourceLineNo">363</span>     ***/<a name="line.363"></a>
<span class="sourceLineNo">364</span>    public boolean getReaderThread()<a name="line.364"></a>
<span class="sourceLineNo">365</span>    {<a name="line.365"></a>
<span class="sourceLineNo">366</span>        return (readerThread);<a name="line.366"></a>
<span class="sourceLineNo">367</span>    }<a name="line.367"></a>
<span class="sourceLineNo">368</span><a name="line.368"></a>
<span class="sourceLineNo">369</span>    /***<a name="line.369"></a>
<span class="sourceLineNo">370</span>     * Register a listener to be notified when new incoming data is<a name="line.370"></a>
<span class="sourceLineNo">371</span>     * available to be read on the {@link #getInputStream input stream}.<a name="line.371"></a>
<span class="sourceLineNo">372</span>     * Only one listener is supported at a time.<a name="line.372"></a>
<span class="sourceLineNo">373</span>     *<a name="line.373"></a>
<span class="sourceLineNo">374</span>     * &lt;p&gt;<a name="line.374"></a>
<span class="sourceLineNo">375</span>     * More precisely, notifications are issued whenever the number of<a name="line.375"></a>
<span class="sourceLineNo">376</span>     * bytes available for immediate reading (i.e., the value returned<a name="line.376"></a>
<span class="sourceLineNo">377</span>     * by {@link InputStream#available}) transitions from zero to non-zero.<a name="line.377"></a>
<span class="sourceLineNo">378</span>     * Note that (in general) multiple reads may be required to empty the<a name="line.378"></a>
<span class="sourceLineNo">379</span>     * buffer and reset this notification, because incoming bytes are being<a name="line.379"></a>
<span class="sourceLineNo">380</span>     * added to the internal buffer asynchronously.<a name="line.380"></a>
<span class="sourceLineNo">381</span>     * &lt;/p&gt;<a name="line.381"></a>
<span class="sourceLineNo">382</span>     *<a name="line.382"></a>
<span class="sourceLineNo">383</span>     * &lt;p&gt;<a name="line.383"></a>
<span class="sourceLineNo">384</span>     * Notifications are only supported when a {@link #setReaderThread<a name="line.384"></a>
<span class="sourceLineNo">385</span>     * reader thread} is enabled for the connection.<a name="line.385"></a>
<span class="sourceLineNo">386</span>     * &lt;/p&gt;<a name="line.386"></a>
<span class="sourceLineNo">387</span>     *<a name="line.387"></a>
<span class="sourceLineNo">388</span>     * @param listener listener to be registered; replaces any previous<a name="line.388"></a>
<span class="sourceLineNo">389</span>     * @since 3.0<a name="line.389"></a>
<span class="sourceLineNo">390</span>     ***/<a name="line.390"></a>
<span class="sourceLineNo">391</span>    public synchronized void registerInputListener(TelnetInputListener listener)<a name="line.391"></a>
<span class="sourceLineNo">392</span>    {<a name="line.392"></a>
<span class="sourceLineNo">393</span>        this.inputListener = listener;<a name="line.393"></a>
<span class="sourceLineNo">394</span>    }<a name="line.394"></a>
<span class="sourceLineNo">395</span><a name="line.395"></a>
<span class="sourceLineNo">396</span>    /***<a name="line.396"></a>
<span class="sourceLineNo">397</span>     * Unregisters the current {@link TelnetInputListener}, if any.<a name="line.397"></a>
<span class="sourceLineNo">398</span>     *<a name="line.398"></a>
<span class="sourceLineNo">399</span>     * @since 3.0<a name="line.399"></a>
<span class="sourceLineNo">400</span>     ***/<a name="line.400"></a>
<span class="sourceLineNo">401</span>    public synchronized void unregisterInputListener()<a name="line.401"></a>
<span class="sourceLineNo">402</span>    {<a name="line.402"></a>
<span class="sourceLineNo">403</span>        this.inputListener = null;<a name="line.403"></a>
<span class="sourceLineNo">404</span>    }<a name="line.404"></a>
<span class="sourceLineNo">405</span><a name="line.405"></a>
<span class="sourceLineNo">406</span>    // Notify input listener<a name="line.406"></a>
<span class="sourceLineNo">407</span>    void notifyInputListener() {<a name="line.407"></a>
<span class="sourceLineNo">408</span>        TelnetInputListener listener;<a name="line.408"></a>
<span class="sourceLineNo">409</span>        synchronized (this) {<a name="line.409"></a>
<span class="sourceLineNo">410</span>            listener = this.inputListener;<a name="line.410"></a>
<span class="sourceLineNo">411</span>        }<a name="line.411"></a>
<span class="sourceLineNo">412</span>        if (listener != null) {<a name="line.412"></a>
<span class="sourceLineNo">413</span>            listener.telnetInputAvailable();<a name="line.413"></a>
<span class="sourceLineNo">414</span>        }<a name="line.414"></a>
<span class="sourceLineNo">415</span>    }<a name="line.415"></a>
<span class="sourceLineNo">416</span>}<a name="line.416"></a>




























































</pre>
</div>
</body>
</html>
